SubdividedEdgeRenderer.java

/*
 Copyright 2008-2012 Gephi
 Authors : Taras Klaskovsky <megaterik@gmail.com>
 Website : http://www.gephi.org

 This file is part of Gephi.

 DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.

 Copyright 2011 Gephi Consortium. All rights reserved.

 The contents of this file are subject to the terms of either the GNU
 General Public License Version 3 only ("GPL") or the Common
 Development and Distribution License("CDDL") (collectively, the
 "License"). You may not use this file except in compliance with the
 License. You can obtain a copy of the License at
 http://gephi.org/about/legal/license-notice/
 or /cddl-1.0.txt and /gpl-3.0.txt. See the License for the
 specific language governing permissions and limitations under the
 License.  When distributing the software, include this License Header
 Notice in each file and include the License files at
 /cddl-1.0.txt and /gpl-3.0.txt. If applicable, add the following below the
 License Header, with the fields enclosed by brackets [] replaced by
 your own identifying information:
 "Portions Copyrighted [year] [name of copyright owner]"

 If you wish your version of this file to be governed by only the CDDL
 or only the GPL Version 3, indicate your decision by adding
 "[Contributor] elects to include this software in this distribution
 under the [CDDL or GPL Version 3] license." If you do not indicate a
 single choice of license, a recipient has the option to distribute
 your version of this file under either the CDDL, the GPL Version 3 or
 to extend the choice of license to its licensees as provided above.
 However, if you add GPL Version 3 code and therefore, elected the GPL
 Version 3 license, then the option applies only if the new code is
 made subject to such option by the copyright holder.

 Contributor(s):

 Portions Copyrighted 2011 Gephi Consortium.
 */
package org.gephi.edgelayout.api;

import com.itextpdf.text.pdf.PdfContentByte;
import com.itextpdf.text.pdf.PdfGState;
import java.awt.Color;
import java.awt.geom.Point2D;
import java.beans.PropertyEditorManager;
import java.util.ArrayList;
import java.util.List;
import java.util.Locale;
import org.gephi.edgelayout.spi.EdgeLayoutData;
import org.gephi.graph.api.Edge;
import org.gephi.preview.api.*;
import org.gephi.preview.spi.ItemBuilder;
import org.gephi.preview.spi.Renderer;
import org.gephi.preview.types.RendererModes;
import org.openide.util.lookup.ServiceProvider;
import org.w3c.dom.Element;
import processing.core.PGraphics;

/**
 *
 * @author Taras Klaskovsky <megaterik@gmail.com>
 */
@ServiceProvider(service = Renderer.class)
public class SubdividedEdgeRenderer implements Renderer {

    private float thickness;
    private float alpha;
    private float intAlpha;
    private boolean forceAlpha;
    private Color originalColor;
    private boolean useSimpleRendererBecauseOtherAreEmpty;

    @Override
    public String getDisplayName() {
        return org.openide.util.NbBundle.getMessage(SubdividedEdgeRenderer.class, "edge_layout_renderer.name");
    }

    @Override
    public void preProcess(PreviewModel previewModel) {
        alpha = (float) previewModel.getProperties().getDoubleValue(PreviewProperty.EDGE_LAYOUT_EDGE_TRANSPARENCY);
        intAlpha = (int) (255 * alpha);
        forceAlpha = (boolean) previewModel.getProperties().getBooleanValue(PreviewProperty.EDGE_LAYOUT_EDGE_TRANSPARENCY_FORCE);
        thickness = (float) previewModel.getProperties().getDoubleValue(PreviewProperty.EDGE_LAYOUT_EDGE_THICKNESS);
        originalColor = previewModel.getProperties().getColorValue(PreviewProperty.EDGE_LAYOUT_SIMPLE_RENDERER_COLOR);
        useSimpleRendererBecauseOtherAreEmpty = false;
        if (!((SubdividedEdgeBigItem) previewModel.getItems("FDEB gradient curve")[0]).isReady()) {
            useSimpleRendererBecauseOtherAreEmpty = true;
        }
    }

    private void renderSimpleItem(SubdividedEdgeItem item, RenderTarget target, PreviewProperties properties) {
        if (item.getSource() == null) {
            return;
        }
        EdgeLayoutData data = (EdgeLayoutData) item.getSource();
        Point2D.Double[] points = data.getSubdivisonPoints();
        if (target instanceof ProcessingTarget) {
            renderSimpleProcessingItem(item, target, properties, points);
        } else if (target instanceof PDFTarget) {
            renderSimplePDFItem(item, target, properties, points);
        } else if (target instanceof SVGTarget) {
            renderSimpleSVGItem(item, target, properties, points, ((Edge) item.getData("edge")).toString());
        }
    }

    private void renderSimpleSVGItem(SubdividedEdgeItem item, RenderTarget target, PreviewProperties properties, Point2D.Double[] points, String classEdge) {
        Color color = new Color(originalColor.getRed(), originalColor.getGreen(), originalColor.getBlue(), (int) (255 * alpha));
        SVGTarget svgTarget = (SVGTarget) target;
        Element edgeElem = svgTarget.createElement("polyline");
        edgeElem.setAttribute("stroke", svgTarget.toHexString(color));
        edgeElem.setAttribute("stroke-width", Float.toString(thickness * svgTarget.getScaleRatio()));
        edgeElem.setAttribute("stroke-opacity", (color.getAlpha() / 255f) + "");
        edgeElem.setAttribute("fill", "none");
        edgeElem.setAttribute("class", classEdge);
        StringBuilder builder = new StringBuilder();
        for (int i = 0; i < points.length; i++) {
            if (i != 0) {
                builder.append(",");
            }
            builder.append(points[i].x).append(" ").append(-points[i].y);
        }
        edgeElem.setAttribute("points", builder.toString());
        svgTarget.getTopElement(SVGTarget.TOP_EDGES).appendChild(edgeElem);

    }

    private void renderSimplePDFItem(SubdividedEdgeItem item, RenderTarget target, PreviewProperties properties, Point2D.Double[] points) {
        Color color = new Color(originalColor.getRed(), originalColor.getGreen(), originalColor.getBlue(), (int) (255 * alpha));
        PDFTarget pdfTarget = (PDFTarget) target;
        PdfContentByte cb = pdfTarget.getContentByte();
        for (int i = 0; i < points.length - 1; i++) {
            cb.moveTo((float) points[i].x, (float) points[i].y);
            cb.lineTo((float) points[i + 1].x, (float) points[i + 1].y);
        }
        cb.setRGBColorStroke(color.getRed(), color.getGreen(), color.getBlue());
        cb.setLineWidth(thickness);
        if (color.getAlpha() < 255) {
            cb.saveState();
            float alpha = color.getAlpha() / 255f;
            PdfGState gState = new PdfGState();
            gState.setStrokeOpacity(alpha);
            cb.setGState(gState);
        }
        cb.stroke();
        if (color.getAlpha() < 255) {
            cb.restoreState();
        }
    }

    private void renderSimpleProcessingItem(SubdividedEdgeItem item, RenderTarget target, PreviewProperties properties, Point2D.Double[] points) {
        assert (originalColor != null);
        Color color = new Color(originalColor.getRed(), originalColor.getGreen(), originalColor.getBlue(), (int) (255 * alpha));
        PGraphics graphics = ((ProcessingTarget) target).getGraphics();
        graphics.noFill();
        graphics.strokeWeight(thickness);
        graphics.strokeCap(PGraphics.ROUND);
        graphics.stroke(color.getRed(), color.getGreen(), color.getBlue(), color.getAlpha());
        graphics.beginShape();

        for (int i = 0; i < points.length; i++) {
            float x1 = (float) points[i].x;
            float y1 = (float) points[i].y;
            graphics.vertex(x1, -y1);
        }
        graphics.endShape();
    }

    @Override
    public void render(Item item, RenderTarget target, PreviewProperties properties) {
        if (item instanceof SubdividedEdgeItem && (properties.getValue(PreviewProperty.EDGE_LAYOUT_USE_RENDERER).equals(RendererModes.SIMPLE) || useSimpleRendererBecauseOtherAreEmpty)) {
            assert (properties.getValue(PreviewProperty.EDGE_LAYOUT_USE_RENDERER).equals(RendererModes.SIMPLE)
                    || useSimpleRendererBecauseOtherAreEmpty);
            renderSimpleItem((SubdividedEdgeItem) item, target, properties);
        } else if (!useSimpleRendererBecauseOtherAreEmpty
                && item instanceof SubdividedEdgeBigItem && properties.getValue(PreviewProperty.EDGE_LAYOUT_USE_RENDERER).equals(RendererModes.GRADIENT)) {
            renderBigItem((SubdividedEdgeBigItem) item, target, properties);
        } else if (!useSimpleRendererBecauseOtherAreEmpty
                && item instanceof SubdividedEdgeBigItem && properties.getValue(PreviewProperty.EDGE_LAYOUT_USE_RENDERER).equals(RendererModes.GRADIENT_COMPLEX)) {
            renderBigAndComplexItem((SubdividedEdgeBigItem) item, target, properties);
        }
    }

    private void renderBigItem(SubdividedEdgeBigItem item, RenderTarget target, PreviewProperties properties) {
        if (target instanceof ProcessingTarget) {
            renderBigProcessingItem(item, target, properties);
        } else if (target instanceof PDFTarget) {
            renderBigPDFItem(item, target, properties);
        } else if (target instanceof SVGTarget) {
            renderBigSVGItem(item, target, properties);
        }
    }

    private void renderBigAndComplexItem(SubdividedEdgeBigItem item, RenderTarget target, PreviewProperties properties) {
        if (target instanceof ProcessingTarget) {
            renderBigAndComplexProcessingItem(item, target, properties);
        } else if (target instanceof PDFTarget) {
            renderBigAndComplexPDFItem(item, target, properties);
        } else if (target instanceof SVGTarget) {
            renderBigAndComplexSVGItem(item, target, properties);
        }
    }

    private void renderBigPDFItem(SubdividedEdgeBigItem item, RenderTarget target, PreviewProperties properties) {
        for (SortedEdgeWrapper edgeWrapper : item.edges) {
            Edge edge = edgeWrapper.edge;
            EdgeLayoutData data = (EdgeLayoutData) edge.getEdgeData().getLayoutData();
            Point2D.Double[] points = data.getSubdivisonPoints();


            if (data.getEdgeColor() == null || points == null) {
                continue;
            }
            Color color = new Color(data.getEdgeColor().getRed(), data.getEdgeColor().getGreen(), data.getEdgeColor().getBlue(), (int) (255 * alpha));
            PDFTarget pdfTarget = (PDFTarget) target;
            PdfContentByte cb = pdfTarget.getContentByte();
            for (int i = 0; i < points.length - 1; i++) {
                cb.moveTo((float) points[i].x, (float) points[i].y);
                cb.lineTo((float) points[i + 1].x, (float) points[i + 1].y);
            }
            cb.setRGBColorStroke(color.getRed(), color.getGreen(), color.getBlue());
            cb.setLineWidth(thickness);

            float usedAlpha = (forceAlpha ? intAlpha : color.getAlpha());
            if (usedAlpha < 255) {
                cb.saveState();
                float alpha = usedAlpha / 255f;
                PdfGState gState = new PdfGState();
                gState.setStrokeOpacity(alpha);
                cb.setGState(gState);
            }
            cb.stroke();
            if (usedAlpha < 255) {
                cb.restoreState();
            }
        }
    }

    private void renderBigSVGItem(SubdividedEdgeBigItem item, RenderTarget target, PreviewProperties properties) {
        for (SortedEdgeWrapper edgeWrapper : item.edges) {
            Edge edge = edgeWrapper.edge;
            EdgeLayoutData data = (EdgeLayoutData) edge.getEdgeData().getLayoutData();
            Point2D.Double[] points = data.getSubdivisonPoints();

            if (data.getEdgeColor() == null || points == null) {
                continue;
            }

            Color color = new Color(data.getEdgeColor().getRed(), data.getEdgeColor().getGreen(), data.getEdgeColor().getBlue());
            SVGTarget svgTarget = (SVGTarget) target;
            Element edgeElem = svgTarget.createElement("polyline");
            edgeElem.setAttribute("stroke", svgTarget.toHexString(color));
            edgeElem.setAttribute("stroke-width", Float.toString(thickness * svgTarget.getScaleRatio()));
            edgeElem.setAttribute("stroke-opacity", ((forceAlpha ? intAlpha : color.getAlpha()) / 255f) + "");
            edgeElem.setAttribute("fill", "none");
            edgeElem.setAttribute("class", edge.toString());
            StringBuilder builder = new StringBuilder();
            for (int i = 0; i < points.length; i++) {
                if (i != 0) {
                    builder.append(",");
                }
                builder.append(points[i].x).append(" ").append(-points[i].y);
            }
            edgeElem.setAttribute("points", builder.toString());
            svgTarget.getTopElement(SVGTarget.TOP_EDGES).appendChild(edgeElem);
        }
    }

    private void renderBigProcessingItem(SubdividedEdgeBigItem item, RenderTarget target, PreviewProperties properties) {
        for (SortedEdgeWrapper edgeWrapper : item.edges) {
            Edge edge = edgeWrapper.edge;
            EdgeLayoutData data = (EdgeLayoutData) edge.getEdgeData().getLayoutData();
            Point2D.Double[] points = data.getSubdivisonPoints();

            if (data.getEdgeColor() == null || points == null) {
                continue;
            }

            PGraphics graphics = ((ProcessingTarget) target).getGraphics();

            graphics.noFill();
            graphics.strokeWeight(thickness);
            graphics.strokeCap(PGraphics.ROUND);
            graphics.stroke(data.getEdgeColor().getRed(), data.getEdgeColor().getGreen(), data.getEdgeColor().getBlue(), forceAlpha ? intAlpha : data.getEdgeColor().getAlpha());
            graphics.beginShape();
            for (int i = 0; i < points.length; i++) {
                float x1 = (float) points[i].x;
                float y1 = (float) points[i].y;
                graphics.vertex(x1, -y1);
            }
            graphics.endShape();
        }
    }

    private void renderBigAndComplexPDFItem(SubdividedEdgeBigItem item, RenderTarget target, PreviewProperties properties) {
        for (SortedEdgeWrapper edgeWrapper : item.edges) {
            Edge edge = edgeWrapper.edge;
            EdgeLayoutData data = (EdgeLayoutData) edge.getEdgeData().getLayoutData();
            Point2D.Double[] points = data.getSubdivisonPoints();

            if (data.getSubdivisionEdgeColor() == null || data.getSubdivisionEdgeColor()[edgeWrapper.id] == null || points == null) {
                continue;
            }

            Color color = data.getSubdivisionEdgeColor()[edgeWrapper.id];
            PDFTarget pdfTarget = (PDFTarget) target;
            PdfContentByte cb = pdfTarget.getContentByte();
            int i = edgeWrapper.id;
            if (i == points.length - 1) {
                continue;
            }
            cb.moveTo((float) points[i].x, (float) points[i].y);
            cb.lineTo((float) points[i + 1].x, (float) points[i + 1].y);
            cb.setRGBColorStroke(color.getRed(), color.getGreen(), color.getBlue());
            cb.setLineWidth(thickness);

            float usedAlpha = (forceAlpha ? intAlpha : color.getAlpha());
            if (usedAlpha < 255) {
                cb.saveState();
                float alpha = usedAlpha / 255f;
                PdfGState gState = new PdfGState();
                gState.setStrokeOpacity(alpha);
                cb.setGState(gState);
            }
            cb.stroke();
            if (usedAlpha < 255) {
                cb.restoreState();
            }
        }
    }

    private void renderBigAndComplexSVGItem(SubdividedEdgeBigItem item, RenderTarget target, PreviewProperties properties) {
        for (SortedEdgeWrapper edgeWrapper : item.edges) {
            Edge edge = edgeWrapper.edge;
            EdgeLayoutData data = (EdgeLayoutData) edge.getEdgeData().getLayoutData();
            Point2D.Double[] points = data.getSubdivisonPoints();
            if (edgeWrapper.id == points.length - 1) {
                continue;
            }

            if (data.getSubdivisionEdgeColor() == null || data.getSubdivisionEdgeColor()[edgeWrapper.id] == null || points == null) {
                continue;
            }

            Color color = data.getSubdivisionEdgeColor()[edgeWrapper.id];
            SVGTarget svgTarget = (SVGTarget) target;
            Element edgeElem = svgTarget.createElement("path");
            edgeElem.setAttribute("class", edge.getSource().getNodeData().getId() + " " + edge.getTarget().getNodeData().getId());
            edgeElem.setAttribute("d", String.format(Locale.ENGLISH, "M %f,%f L %f,%f",
                    points[edgeWrapper.id].x, -points[edgeWrapper.id].y, points[edgeWrapper.id + 1].x, -points[edgeWrapper.id + 1].y));
            edgeElem.setAttribute("stroke", svgTarget.toHexString(color));
            edgeElem.setAttribute("stroke-width", Float.toString(thickness * svgTarget.getScaleRatio()));
            edgeElem.setAttribute("stroke-opacity", ((forceAlpha ? intAlpha : color.getAlpha()) / 255f) + "");
            edgeElem.setAttribute("fill", "none");
            svgTarget.getTopElement(SVGTarget.TOP_EDGES).appendChild(edgeElem);
        }
    }

    private void renderBigAndComplexProcessingItem(SubdividedEdgeBigItem item, RenderTarget target, PreviewProperties properties) {
        for (SortedEdgeWrapper edgeWrapper : item.edges) {
            Edge edge = edgeWrapper.edge;
            EdgeLayoutData data = (EdgeLayoutData) edge.getEdgeData().getLayoutData();
            Point2D.Double[] points = data.getSubdivisonPoints();
            if (data.getSubdivisonPoints() == null || data.getSubdivisionEdgeColor() == null
                    || edgeWrapper.id == data.getSubdivisonPoints().length - 1) {
                continue;
            }

            if (data.getSubdivisionEdgeColor() == null || data.getSubdivisionEdgeColor()[edgeWrapper.id] == null || points == null) {
                continue;
            }
            PGraphics graphics = ((ProcessingTarget) target).getGraphics();

            graphics.noFill();
            graphics.strokeWeight(thickness);
            graphics.strokeCap(PGraphics.ROUND);
            Color color = data.getSubdivisionEdgeColor()[edgeWrapper.id];
            if (color == null) {
                continue;
            }
            graphics.stroke(color.getRed(), color.getGreen(), color.getBlue(), (forceAlpha ? intAlpha : color.getAlpha()));
            graphics.line((float) points[edgeWrapper.id].x, -(float) points[edgeWrapper.id].y, (float) points[edgeWrapper.id + 1].x, -(float) points[edgeWrapper.id + 1].y);
        }
    }

    @Override
    public PreviewProperty[] getProperties() {
        List<PreviewProperty> properties = new ArrayList<PreviewProperty>();
        PropertyEditorManager.registerEditor(RendererModes.class, RenderModePropertyEditor.class);
        properties.add(PreviewProperty.createProperty(this,
                PreviewProperty.EDGE_LAYOUT_USE_RENDERER,
                RendererModes.class,
                org.openide.util.NbBundle.getMessage(SubdividedEdgeRenderer.class, "renderer_mode.name"),
                org.openide.util.NbBundle.getMessage(SubdividedEdgeRenderer.class, "renderer_mode.desc"),
                PreviewProperty.CATEGORY_EDGE_LAYOUT).setValue(RendererModes.SIMPLE));

        properties.add(PreviewProperty.createProperty(this,
                PreviewProperty.EDGE_LAYOUT_REFRESH_RATE,
                Integer.class,
                org.openide.util.NbBundle.getMessage(SubdividedEdgeRenderer.class, "refresh_rate.name"),
                org.openide.util.NbBundle.getMessage(SubdividedEdgeRenderer.class, "refresh_rate.desc"),
                PreviewProperty.CATEGORY_EDGE_LAYOUT).setValue(1));

        properties.add(PreviewProperty.createProperty(this,
                PreviewProperty.EDGE_LAYOUT_EDGE_THICKNESS,
                Double.class,
                org.openide.util.NbBundle.getMessage(SubdividedEdgeRenderer.class, "edge_thickness.name"),
                org.openide.util.NbBundle.getMessage(SubdividedEdgeRenderer.class, "edge_thickness.desc"),
                PreviewProperty.CATEGORY_EDGE_LAYOUT).setValue(0.5));

        properties.add(PreviewProperty.createProperty(this,
                PreviewProperty.EDGE_LAYOUT_EDGE_TRANSPARENCY,
                Double.class,
                org.openide.util.NbBundle.getMessage(SubdividedEdgeRenderer.class, "edge_transparency.name"),
                org.openide.util.NbBundle.getMessage(SubdividedEdgeRenderer.class, "edge_transparency.desc"),
                PreviewProperty.CATEGORY_EDGE_LAYOUT).setValue(0.1));

        properties.add(PreviewProperty.createProperty(this,
                PreviewProperty.EDGE_LAYOUT_EDGE_TRANSPARENCY_FORCE,
                Boolean.class,
                org.openide.util.NbBundle.getMessage(SubdividedEdgeRenderer.class, "force_edge_transparency.name"),
                org.openide.util.NbBundle.getMessage(SubdividedEdgeRenderer.class, "force_edge_transparency.desc"),
                PreviewProperty.CATEGORY_EDGE_LAYOUT).setValue(false));

        properties.add(PreviewProperty.createProperty(this,
                PreviewProperty.EDGE_LAYOUT_SIMPLE_RENDERER_COLOR,
                Color.class,
                org.openide.util.NbBundle.getMessage(SubdividedEdgeRenderer.class, "simple_renderer_color.name"),
                org.openide.util.NbBundle.getMessage(SubdividedEdgeRenderer.class, "simple_renderer_color.desc"),
                PreviewProperty.CATEGORY_EDGE_LAYOUT).setValue(new Color(0f, 0f, 0.5f)));

        properties.add(PreviewProperty.createProperty(this,
                PreviewProperty.EDGE_LAYOUT_USE_PERCENTAGE_INSTEAD_OF_LINEAR_SCALE,
                Boolean.class,
                org.openide.util.NbBundle.getMessage(SubdividedEdgeRenderer.class, "use_relative_value.name"),
                org.openide.util.NbBundle.getMessage(SubdividedEdgeRenderer.class, "use_relative_name.desc"),
                PreviewProperty.CATEGORY_EDGE_LAYOUT).setValue(true));

        properties.add(PreviewProperty.createProperty(this,
                PreviewProperty.EDGE_LAYOUT_PRECALCULATE_POINTS,
                Boolean.class,
                org.openide.util.NbBundle.getMessage(SubdividedEdgeRenderer.class, "precalculate_points.name"),
                org.openide.util.NbBundle.getMessage(SubdividedEdgeRenderer.class, "precalculate_points.desc"),
                PreviewProperty.CATEGORY_EDGE_LAYOUT).setValue(false));

        return properties.toArray(new PreviewProperty[0]);
    }

    @Override
    public boolean isRendererForitem(Item item, PreviewProperties properties) {
        return (item instanceof SubdividedEdgeItem
                || (item instanceof SubdividedEdgeBigItem && !properties.getValue(PreviewProperty.EDGE_LAYOUT_USE_RENDERER).equals(RendererModes.SIMPLE)));
    }

    @Override
    public boolean needsItemBuilder(ItemBuilder itemBuilder, PreviewProperties properties) {
        return (itemBuilder instanceof SubdividedEdgeItemBuilder || itemBuilder instanceof SubdividedEdgeBigItemBuilder);
    }
}